

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Command Line Interface &mdash; Optuna 1.4.0 文档</title>
  

  
  
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/language_data.js"></script>
        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
    <link rel="index" title="索引" href="../genindex.html" />
    <link rel="search" title="搜索" href="../search.html" />
    <link rel="next" title="Distributions" href="distributions.html" />
    <link rel="prev" title="Core" href="core.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html" class="icon icon-home"> Optuna
          

          
          </a>

          
            
            
              <div class="version">
                1.4.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">目录</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">安装</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">教程</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="core.html">Core</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Command Line Interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#create-study">create-study</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dashboard">dashboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="#delete-study">delete-study</a></li>
<li class="toctree-l3"><a class="reference internal" href="#storage-upgrade">storage upgrade</a></li>
<li class="toctree-l3"><a class="reference internal" href="#studies">studies</a></li>
<li class="toctree-l3"><a class="reference internal" href="#study-optimize">study optimize</a></li>
<li class="toctree-l3"><a class="reference internal" href="#study-set-user-attr">study set-user-attr</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="distributions.html">Distributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="importance.html">Hyperparameter Importance</a></li>
<li class="toctree-l2"><a class="reference internal" href="integration.html">Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="multi_objective/index.html">Multi-objective</a></li>
<li class="toctree-l2"><a class="reference internal" href="pruners.html">Pruners</a></li>
<li class="toctree-l2"><a class="reference internal" href="samplers.html">Samplers</a></li>
<li class="toctree-l2"><a class="reference internal" href="storages.html">Storages</a></li>
<li class="toctree-l2"><a class="reference internal" href="structs.html">Structs</a></li>
<li class="toctree-l2"><a class="reference internal" href="study.html">Study</a></li>
<li class="toctree-l2"><a class="reference internal" href="trial.html">Trial</a></li>
<li class="toctree-l2"><a class="reference internal" href="visualization.html">Visualization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">常见问题</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Optuna</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">API Reference</a> &raquo;</li>
        
      <li>Command Line Interface</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/reference/cli.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="command-line-interface">
<h1>Command Line Interface<a class="headerlink" href="#command-line-interface" title="永久链接至标题">¶</a></h1>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna
    <span class="o">[</span>--version<span class="o">]</span>
    <span class="o">[</span>-v <span class="p">|</span> -q<span class="o">]</span>
    <span class="o">[</span>--log-file LOG_FILE<span class="o">]</span>
    <span class="o">[</span>--debug<span class="o">]</span>
    <span class="o">[</span>--storage STORAGE<span class="o">]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-version">
<code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-version" title="永久链接至目标">¶</a></dt>
<dd><p>显示应用的版本号并退出</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-v">
<span id="cmdoption-optuna-verbose"></span><code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--verbose</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-v" title="永久链接至目标">¶</a></dt>
<dd><p>打印冗余内容。可重复。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-q">
<span id="cmdoption-optuna-quiet"></span><code class="sig-name descname">-q</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-q" title="永久链接至目标">¶</a></dt>
<dd><p>禁止打印除了警告和错误之外的输出。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> &lt;LOG_FILE&gt;</code><a class="headerlink" href="#cmdoption-optuna-log-file" title="永久链接至目标">¶</a></dt>
<dd><p>确定用于记录日志的文件名。该选项默认情况下是禁用的。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-debug" title="永久链接至目标">¶</a></dt>
<dd><p>显示异常处理和堆栈跟踪信息。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-storage">
<code class="sig-name descname">--storage</code><code class="sig-prename descclassname"> &lt;STORAGE&gt;</code><a class="headerlink" href="#cmdoption-optuna-storage" title="永久链接至目标">¶</a></dt>
<dd><p>数据库 URL. (比如 <code class="docutils literal notranslate"><span class="pre">sqlite:///example.db</span></code> )</p>
</dd></dl>

<div class="section" id="create-study">
<h2>create-study<a class="headerlink" href="#create-study" title="永久链接至标题">¶</a></h2>
<p>创建新的 study</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna create-study
    <span class="o">[</span>--study-name STUDY_NAME<span class="o">]</span>
    <span class="o">[</span>--direction <span class="o">{</span>minimize,maximize<span class="o">}]</span>
    <span class="o">[</span>--skip-if-exists<span class="o">]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-create-study-study-name">
<code class="sig-name descname">--study-name</code><code class="sig-prename descclassname"> &lt;STUDY_NAME&gt;</code><a class="headerlink" href="#cmdoption-optuna-create-study-study-name" title="永久链接至目标">¶</a></dt>
<dd><p>设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-create-study-direction">
<code class="sig-name descname">--direction</code><code class="sig-prename descclassname"> &lt;DIRECTION&gt;</code><a class="headerlink" href="#cmdoption-optuna-create-study-direction" title="永久链接至目标">¶</a></dt>
<dd><p>设定新 study 的优化方向。如果方向是最小化的话就设成 'minimize', 如果是最大化就设置成 'maximize'.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-create-study-skip-if-exists">
<code class="sig-name descname">--skip-if-exists</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-create-study-skip-if-exists" title="永久链接至目标">¶</a></dt>
<dd><p>如果开启该选项， 当存在一个同名的 study 时，optuna 在优化开始时将跳过创建 study 的过程，并且不报错。</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="dashboard">
<h2>dashboard<a class="headerlink" href="#dashboard" title="永久链接至标题">¶</a></h2>
<p>启动 web dashboard (beta).</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna dashboard
    <span class="o">[</span>--study STUDY<span class="o">]</span>
    <span class="o">[</span>--study-name STUDY_NAME<span class="o">]</span>
    <span class="o">[</span>--out OUT<span class="o">]</span>
    <span class="o">[</span>--allow-websocket-origin BOKEH_ALLOW_WEBSOCKET_ORIGINS<span class="o">]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-dashboard-study">
<code class="sig-name descname">--study</code><code class="sig-prename descclassname"> &lt;STUDY&gt;</code><a class="headerlink" href="#cmdoption-optuna-dashboard-study" title="永久链接至目标">¶</a></dt>
<dd><p>该参数已弃用。作为替代，请使用  –study-name.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-dashboard-study-name">
<code class="sig-name descname">--study-name</code><code class="sig-prename descclassname"> &lt;STUDY_NAME&gt;</code><a class="headerlink" href="#cmdoption-optuna-dashboard-study-name" title="永久链接至目标">¶</a></dt>
<dd><p>设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-dashboard-out">
<span id="cmdoption-optuna-dashboard-o"></span><code class="sig-name descname">--out</code><code class="sig-prename descclassname"> &lt;OUT&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">-o</code><code class="sig-prename descclassname"> &lt;OUT&gt;</code><a class="headerlink" href="#cmdoption-optuna-dashboard-out" title="永久链接至目标">¶</a></dt>
<dd><p>HTML 文件的输出路径。如果该参数没有设定的话，Optuna 将会启动一个 HTTP server 并host 一个dashboard</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-dashboard-allow-websocket-origin">
<code class="sig-name descname">--allow-websocket-origin</code><code class="sig-prename descclassname"> &lt;BOKEH_ALLOW_WEBSOCKET_ORIGINS&gt;</code><a class="headerlink" href="#cmdoption-optuna-dashboard-allow-websocket-origin" title="永久链接至目标">¶</a></dt>
<dd><p>允许从制定的 host 发起的的 websocket 请求。该选项用法和 bokeh 的 <code class="docutils literal notranslate"><span class="pre">–allow-websocket-origin</span></code> 一样。更多细节见 <a class="reference external" href="https://docs.bokeh.org/en/latest/docs/reference/command/subcommands/serve.html">https://docs.bokeh.org/en/latest/docs/reference/command/subcommands/serve.html</a>.设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="delete-study">
<h2>delete-study<a class="headerlink" href="#delete-study" title="永久链接至标题">¶</a></h2>
<p>删除特定的 study.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna delete-study <span class="o">[</span>--study-name STUDY_NAME<span class="o">]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-delete-study-study-name">
<code class="sig-name descname">--study-name</code><code class="sig-prename descclassname"> &lt;STUDY_NAME&gt;</code><a class="headerlink" href="#cmdoption-optuna-delete-study-study-name" title="永久链接至目标">¶</a></dt>
<dd><p>设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="storage-upgrade">
<h2>storage upgrade<a class="headerlink" href="#storage-upgrade" title="永久链接至标题">¶</a></h2>
<p>升级数据库架构。</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna storage upgrade
</pre></div>
</div>
<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="studies">
<h2>studies<a class="headerlink" href="#studies" title="永久链接至标题">¶</a></h2>
<p>显示 study 列表。</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna studies
    <span class="o">[</span>-f <span class="o">{</span>csv,json,table,value,yaml<span class="o">}]</span>
    <span class="o">[</span>-c COLUMN<span class="o">]</span>
    <span class="o">[</span>--quote <span class="o">{</span>all,minimal,none,nonnumeric<span class="o">}]</span>
    <span class="o">[</span>--noindent<span class="o">]</span>
    <span class="o">[</span>--max-width &lt;integer&gt;<span class="o">]</span>
    <span class="o">[</span>--fit-width<span class="o">]</span>
    <span class="o">[</span>--print-empty<span class="o">]</span>
    <span class="o">[</span>--sort-column SORT_COLUMN<span class="o">]</span>
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-studies-f">
<span id="cmdoption-optuna-studies-format"></span><code class="sig-name descname">-f</code><code class="sig-prename descclassname"> &lt;FORMATTER&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--format</code><code class="sig-prename descclassname"> &lt;FORMATTER&gt;</code><a class="headerlink" href="#cmdoption-optuna-studies-f" title="永久链接至目标">¶</a></dt>
<dd><p>输出格式，默认情况下是表格。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-c">
<span id="cmdoption-optuna-studies-column"></span><code class="sig-name descname">-c</code><code class="sig-prename descclassname"> COLUMN</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--column</code><code class="sig-prename descclassname"> COLUMN</code><a class="headerlink" href="#cmdoption-optuna-studies-c" title="永久链接至目标">¶</a></dt>
<dd><p>用于设定要展示的（表格）列。可设置多个 column 参数以同时显示多个column.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-quote">
<code class="sig-name descname">--quote</code><code class="sig-prename descclassname"> &lt;QUOTE_MODE&gt;</code><a class="headerlink" href="#cmdoption-optuna-studies-quote" title="永久链接至目标">¶</a></dt>
<dd><p>when to include quotes, defaults to nonnumeric</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-noindent">
<code class="sig-name descname">--noindent</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-studies-noindent" title="永久链接至目标">¶</a></dt>
<dd><p>设定是否在 json输出格式中禁用缩进。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-max-width">
<code class="sig-name descname">--max-width</code><code class="sig-prename descclassname"> &lt;integer&gt;</code><a class="headerlink" href="#cmdoption-optuna-studies-max-width" title="永久链接至目标">¶</a></dt>
<dd><p>最大展示宽度。如果设置成小于 1 的数值，就代表禁用最大宽度限制。你也可以通过设置 <code class="docutils literal notranslate"><span class="pre">CLIFF_MAX_TERM_WIDTH</span> <span class="pre">``</span> <span class="pre">环境变量来限制最大宽度，但是</span> <span class="pre">``--max-width</span></code> 参数的优先级比环境变量高。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-fit-width">
<code class="sig-name descname">--fit-width</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-studies-fit-width" title="永久链接至目标">¶</a></dt>
<dd><p>将输出表格设置成与显示屏同宽。如果 <code class="docutils literal notranslate"><span class="pre">-max-width</span></code> &gt; 1 的话，该选项会自动启用。设定是否在 json 中禁用缩进。也可以通过设置 <code class="docutils literal notranslate"><span class="pre">CLIFF_FIT_WIDTH</span></code> 环境变量的值为 1 来启用该选项。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-print-empty">
<code class="sig-name descname">--print-empty</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-studies-print-empty" title="永久链接至目标">¶</a></dt>
<dd><p>在无数据的情况下也输出空表格</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-studies-sort-column">
<code class="sig-name descname">--sort-column</code><code class="sig-prename descclassname"> SORT_COLUMN</code><a class="headerlink" href="#cmdoption-optuna-studies-sort-column" title="永久链接至目标">¶</a></dt>
<dd><p>按照指定列来对表格的行进行排序。越靠前指定的列在排序中的优先级越高。没有被指定的列不参与排序。</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="study-optimize">
<h2>study optimize<a class="headerlink" href="#study-optimize" title="永久链接至标题">¶</a></h2>
<p>针对特定 study 开始优化过程。</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna study optimize
    <span class="o">[</span>--n-trials N_TRIALS<span class="o">]</span>
    <span class="o">[</span>--timeout TIMEOUT<span class="o">]</span>
    <span class="o">[</span>--n-jobs N_JOBS<span class="o">]</span>
    <span class="o">[</span>--study STUDY<span class="o">]</span>
    <span class="o">[</span>--study-name STUDY_NAME<span class="o">]</span>
    file
    method
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-n-trials">
<code class="sig-name descname">--n-trials</code><code class="sig-prename descclassname"> &lt;N_TRIALS&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-optimize-n-trials" title="永久链接至目标">¶</a></dt>
<dd><p>优化过程将运行的总 trial 数目。如果不设定该数目的话，优化过程会一直持续下去。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-timeout">
<code class="sig-name descname">--timeout</code><code class="sig-prename descclassname"> &lt;TIMEOUT&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-optimize-timeout" title="永久链接至目标">¶</a></dt>
<dd><p>到达指定时间（按秒计）以后终止 study. 如果不设定该数目的话，优化过程也会一直持续下去。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-n-jobs">
<code class="sig-name descname">--n-jobs</code><code class="sig-prename descclassname"> &lt;N_JOBS&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-optimize-n-jobs" title="永久链接至目标">¶</a></dt>
<dd><p>并行运行的任务个数。如果该参数设置为 -1, 则任务的实际数目将等于 CPU 的核心数。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-study">
<code class="sig-name descname">--study</code><code class="sig-prename descclassname"> &lt;STUDY&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-optimize-study" title="永久链接至目标">¶</a></dt>
<dd><p>该参数已弃用。作为替代，请使用  –study-name.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-study-name">
<code class="sig-name descname">--study-name</code><code class="sig-prename descclassname"> &lt;STUDY_NAME&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-optimize-study-name" title="永久链接至目标">¶</a></dt>
<dd><p>设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-arg-file">
<code class="sig-name descname">file</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-study-optimize-arg-file" title="永久链接至目标">¶</a></dt>
<dd><p>用于指定定义了目标函数的 Python 脚本文件名。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-optimize-arg-method">
<code class="sig-name descname">method</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-optuna-study-optimize-arg-method" title="永久链接至目标">¶</a></dt>
<dd><p>目标函数的方法名。</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
<div class="section" id="study-set-user-attr">
<h2>study set-user-attr<a class="headerlink" href="#study-set-user-attr" title="永久链接至标题">¶</a></h2>
<p>针对特定 study 设定用户属性 (user attribute).</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>optuna study set-user-attr
    <span class="o">[</span>--study STUDY<span class="o">]</span>
    <span class="o">[</span>--study-name STUDY_NAME<span class="o">]</span>
    --key KEY
    --value VALUE
</pre></div>
</div>
<dl class="std option">
<dt id="cmdoption-optuna-study-set-user-attr-study">
<code class="sig-name descname">--study</code><code class="sig-prename descclassname"> &lt;STUDY&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-set-user-attr-study" title="永久链接至目标">¶</a></dt>
<dd><p>该参数已弃用。作为替代，请使用  –study-name.</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-set-user-attr-study-name">
<code class="sig-name descname">--study-name</code><code class="sig-prename descclassname"> &lt;STUDY_NAME&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-set-user-attr-study-name" title="永久链接至目标">¶</a></dt>
<dd><p>设定具有可读性的 study 名，以方便和其他的 study 区分。</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-set-user-attr-key">
<span id="cmdoption-optuna-study-set-user-attr-k"></span><code class="sig-name descname">--key</code><code class="sig-prename descclassname"> &lt;KEY&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">-k</code><code class="sig-prename descclassname"> &lt;KEY&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-set-user-attr-key" title="永久链接至目标">¶</a></dt>
<dd><p>设定用户属性中的键 (key).</p>
</dd></dl>

<dl class="std option">
<dt id="cmdoption-optuna-study-set-user-attr-value">
<span id="cmdoption-optuna-study-set-user-attr-v"></span><code class="sig-name descname">--value</code><code class="sig-prename descclassname"> &lt;VALUE&gt;</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">-v</code><code class="sig-prename descclassname"> &lt;VALUE&gt;</code><a class="headerlink" href="#cmdoption-optuna-study-set-user-attr-value" title="永久链接至目标">¶</a></dt>
<dd><p>设定用户属性中的值 (value).</p>
</dd></dl>

<p>该命令由 optuna 插件提供。</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="distributions.html" class="btn btn-neutral float-right" title="Distributions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="core.html" class="btn btn-neutral float-left" title="Core" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Optuna Contributors.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
    <a href="../privacy.html">Privacy Policy</a>.
     


</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
    <!-- Theme Analytics -->
    <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

    ga('create', 'UA-55135190-8', 'auto');
    ga('send', 'pageview');
    </script>

    
   

</body>
</html>